/*
 * Copyright (c) 2007 Aleksey Nikiforov
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * * Neither the name of 'Aleksey Nikiforov' nor the names of other contributors 
 *   may be used to endorse or promote products derived from this software 
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.lex.input.effects.interpolation;

public interface ClampedInterpolation {
	
	public void update(float deltaT);

	public void clear();

	public boolean isAlive();

	public boolean isAcceleratingPastInitial();

	/**
	 * The range of interpolation is set during initialization. This method
	 * controls what happens if interpolation goes on past initial range.
	 * This can happen if the goal is constantly moving due to user's input.
	 * 
	 * @param accelerate
	 */
	public void setAcceleratePastInitial(boolean accelerate);
	
	public float getSnapDistance();
	
	/**
	 * If the current state of interpolation is in range (goal - snapDistance)
	 * then the acceleration will kick in.
	 * Only useful if acceleratePastInitial is enabled.
	 * 
	 * @param snapDistance
	 */
	public void setSnapDistance(float snapDistance);
	
	public float getAccelerationFactor();
	
	/**
	 * Acceleration factor controls how much faster the interpolation will get
	 * every second. For example, an acceleration factor of 1000 means that
	 * interpolation should become 1000 times faster every second.
	 * 
	 * @param factor
	 */
	public void setAccelerationFactor(float factor);
	
	public float getMaxSpeed();
	
	/**
	 * MaxSpeed is ignored when acceleration is activated.
	 * maxSpeed = 0 means use no speed limit.
	 */
	public void setMaxSpeed(float maxSpeed);
}